- 首页
-
RESTful API
- 通用(Common)
- 账户(Identity)
- 账户-用户(Identity-User)
- 账户-角色(Identity-Role)
- 账户-组织(Identity-Organization)
- 仪表板(Dashboard)
- 仪表板-场景(Scene)
- 仪表板-可视化模板(VizTemplate)
-
共享资源(Shared-Resources)
- 数据-数据源(Datasource)
- 数据-数据集(Dataset)
- 数据-数据模型(DataModel)
- 数据-物联网数据
- 文档-草稿
- 文档-标签
- 文档-文档(Documents)
- 语言包
- 报表-预览(Reporting-RenderResults)
- 报表-报表(Reporting-Reports)
- 报表-缓存设置(Reporting-CachingSettings)
- 报表-导出模板(Reporting-ExportTemplates)
- 报表-自定义函数(Reporting-UserFunctions)
- JavaScript API
Shared-Resources
Shared-Resources
[POST] /api/v2/shared-resources/language-resources/import-by-excel
通过excel导入语言资源
参数:
| 名称 | 类型 | 位置 |
|---|---|---|
| docId | string | query |
返回值
状态码: 200
成功
状态码: 400
错误的请求
[GET] /api/v2/shared-resources/language-resources
根据指定的标准检索语言资源信息。
参数:
| 名称 | 类型 | 位置 | 描述 |
|---|---|---|---|
| docId | string | query | 用于过滤语言资源的文档 ID。如果指定，则仅返回与此文档相关的资源。可选。示例：“doc123” |
| lngs | string | query | 用于过滤结果的语言的逗号分隔列表。如果指定，则仅返回这些语言的资源。可选。示例：“en,fr,es” |
| keys | string | query | 用于过滤语言值的键的逗号分隔列表。如果指定，则仅返回这些键的值。可选。示例：“key1,key2,key3” |
返回值
状态码: 200
成功
状态码: 400
错误的请求
[GET] /api/v2/shared-resources/web-pages/{id}
通过标识符查询有关特定网页的信息。
参数:
| 名称 | 类型 | 位置 | 描述 |
|---|---|---|---|
| id必填项 | string | path | 网页的唯一标识符，通常为 GUID。示例：123e4567-e89b-12d3-a456-426614174000 |
返回值
状态码: 200
成功
状态码: 400
错误的请求
状态码: 404
未找到
[PUT] /api/v2/shared-resources/web-pages/{id}
更新系统中现有的网页。
参数:
| 名称 | 类型 | 位置 | 描述 |
|---|---|---|---|
| id必填项 | string | path | 要更新的网页的唯一标识符。 |
请求数据格式
返回值
状态码: 204
无内容
状态码: 400
错误的请求
状态码: 404
未找到
[POST] /api/v2/shared-resources/web-pages
向系统添加新的网页。
请求数据格式
返回值
状态码: 200
成功
状态码: 400
错误的请求
类型定义
Ƭ ImportLanguageResourceModel
导入语言资源响应模型
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| id可为空 | string | 新的语言资源文档 ID |
Ƭ SharedResourcePluginError
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| code可为空 | string | 错误代码 | |
| message可为空 | string | 错误信息 | |
| context可为空 | string | 错误上下文 | |
| innerError | SharedResourcePluginError |
Ƭ LanguageVo
表示语言信息的集合，封装了有关多种语言的详细信息。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| languagesInfo可为空 | LanguageInfo | 语言信息列表，每个条目包含有关特定语言的详细信息。 |
Ƭ LanguageInfo
表示有关特定语言的详细信息，包括其标识符和相关语言记录。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| id可为空 | string | 该语言的唯一标识符。 | |
| languageRecords可为空 | LanguageRecordInfo | 与此语言关联的语言记录列表。每条记录包含特定键的本地化文本。 |
Ƭ LanguageRecordInfo
表示单一语言记录，封装名称和与其关联的值列表。 此模型用于存储和表示某种语言中特定键的本地化文本值。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| name可为空 | string | 语言记录的名称或键。这充当本地化文本条目的标识符。 | |
| values可为空 | LanguageValueViewModel | 与此语言记录关联的本地化文本值列表。列表中的每个条目代表 特定语言的本地化值，由语言代码标识。 |
Ƭ LanguageValueViewModel
表示语言值的视图模型。此模型用于封装特定于语言的字符串的键值对表示，从而便于在 UI 组件中显示和操作。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| key可为空 | string | 获取语言值的键。此键通常用作本地化上下文中特定字符串的标识符。 | |
| value可为空 | string | 获取与键关联的本地化字符串值。此值是将在 UI 中显示的实际文本。 |
Ƭ QueryWebPageInfoResponseModel
表示检索有关网页信息的查询操作的响应模型。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| id可为空 | string | 网页的唯一标识符。 | |
| title可为空 | string | 网页的标题。 | |
| url可为空 | string | 网页的 URL。 |
Ƭ UpdateWebPageRequestModel
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| comments可为空 | string | ||
| url可为空 | string |
Ƭ AddWebPageResponseModel
表示网页添加操作的响应模型。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| documentId可为空 | string | 已添加的网页文档的唯一标识符。 |
Ƭ AddWebPageRequestModel
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| name可为空 | string | ||
| url可为空 | string | ||
| tagIds可为空 | Array<string> |
||
| comments可为空 | string |